Favicon

You are here: Home > API Reference > Platform > Organization Collaborators > Get list all collaborators group by user

Get list all collaborators group by user

Required Permission: base.people.organizationCollaborator.listAll

Get list all collaborators group by user

GET
https://api.applivery.io/v1/organizations/{organizationId}/collaborators/all 
curl -X GET "https://api.applivery.io/v1/organizations/{organizationId}/collaborators/all" \
  -H "Authorization: Bearer <YOUR_API_KEY>"
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/collaborators/all", {
  method: "GET",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
  },
});

const data = await response.json();
import requests

response = requests.get(
    "https://api.applivery.io/v1/organizations/{organizationId}/collaborators/all",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

role string
optional
owneradmineditorviewerunassigned
email string
optional
≤ 256 characters
tags array
optional
applicationId string
optional
Match pattern: ^[a-fA-F0-9]{24}$

Responses

200 Response application/json
status boolean required
data array [object] required
user object required
id string required
Match pattern: ^[a-fA-F0-9]{24}$
email string required
≤ 256 characters · Match pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ · Format: email
firstName string required
≤ 128 characters
lastName string required
≤ 128 characters
picture string optional
role string required
user serviceAccount platformUser platformServiceAccount
ssoUser any required
has2FAActive any required
collaborators array [object] required
collaboratorType string required
≤ 128 characters
id string required
Match pattern: ^[a-fA-F0-9]{24}$
organization string required
Match pattern: ^[a-fA-F0-9]{24}$
application object required
role string required
owner admin editor viewer unassigned
tags array required
detected object required
createdBy string required
Match pattern: ^[a-fA-F0-9]{24}$
updatedAt string required
createdAt string required 
{
    "status": true,
    "data": [
        {
            "user": {
                "id": "string",
                "email": "[email protected]",
                "firstName": "string",
                "lastName": "string",
                "picture": "string",
                "role": "user",
                "ssoUser": true,
                "has2FAActive": true
            },
            "collaborators": [
                {
                    "collaboratorType": "string",
                    "id": "string",
                    "organization": "string",
                    "application": {
                        "_id": "string",
                        "description": "string",
                        "name": "string",
                        "slug": "string"
                    },
                    "role": "owner",
                    "tags": [
                        "string"
                    ],
                    "detected": {},
                    "createdBy": "string",
                    "updatedAt": "string",
                    "createdAt": "string"
                }
            ]
        }
    ]
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}